Cancelling Authorization
Cancelling an authorization
Use this endpoint to cancel an Automatic Pix authorization
Request
POST 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations/:cancellationIdentifier/cancellations'
Headers
| Name | Description |
|---|---|
| Authorization | Required. API key |
Path Parameters:
| Name | Type | Description |
|---|---|---|
| cancellationIdentifier | string | Required. Cancelation identifier |
Body Attributes
| Name | Type | Description |
|---|---|---|
| payerAccountType | string | Required. Type of payer, domains: NATURAL LEGAL |
| cancellationReqDocument | string | Required. Document |
| cancellationReason | enum | The reason for the cancellation, domains: ACCOUNT_CLOSED - The payer or beneficiary account was closed COMPANY_CLOSED - The receiving company was closed PAYER_DECEASED - The payer passed away REQUEST_ERROR_BY_RECEIVER - Error in the request by the beneficiary or participant FRAUD_SUSPECTED - Suspicion of fraud DUPLICATE_CONFIRMATION - Confirmation was duplicated REQUESTED_BY_PAYEE - The beneficiary requested REQUESTED_BY_PAYER The payer requested NO_RESPONSE_TO_PAIN009 No answer to pain.009 within the regulatory deadline |
Body
{
"payerAccountType": "NATURAL",
"cancellationReqDocument": "12345678000199",
"cancellationReason": "REQUESTED_BY_PAYEE"
}
Response
The status code 200 indicates success in the query.
Being succeeded, the return will have the following fields in Json format:
{
"idRecorrencia":"RR0435879820240605njua7shf40o",
"idCancelamento":"IC0435879820240605bcdb1fhn43a",
"dtHrCancelamento":"2024-06-13T10:10:06.101Z"
}
Fetch cancelled authorization
This endpoint will fetch a cancelled authorization
Request
GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations/:recurrenceId/cancellations/:cancellationIdentifier'
Headers
| Name | Description |
|---|---|
| Authorization | Required. API key |
Path Parameters:
| Name | Type | Description |
|---|---|---|
| authorizationIdentifier | string | Required. Authorization identifier |
| cancellationIdentifier | string | Required. Cancelation identifier |
Response
The status code 200 indicates success in the query.
Being succeeded, the return will have the following fields in Json format:
{
"RecurrenceId":"RR0435879820240605njua7shf40o",
"CancellationId":"IC0435879820240605bcdb1fhn43a",
"RequesterPersonType": "NATURAL",
"RequesterDocument":77379362038,
"CancellationReason":6,
"CancellationAt":"2024-09-17T10:10:06.101Z",
"CancellationStatus": "0"
}